Add some menu markup documentation
authorMatthias Clasen <mclasen@redhat.com>
Thu, 26 Jan 2012 01:58:55 +0000 (20:58 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 26 Jan 2012 01:59:22 +0000 (20:59 -0500)
gtk/gtkapplicationwindow.c

index 6115ba5e4c700ef703c85e0fa8bee17946d69aba..f048ea49cdf98d3fa79b1595cfd9dc91466700b7 100644 (file)
  * ]]>
  * </programlisting>
  * </example>
+ *
+ * The XML format understood by #GtkBuilder for #GMenuModel consists
+ * of a toplevel <tag class="starttag">menu</tag> element, which contains
+ * one or more <tag class="starttag">item</tag> elements. Each
+ * <tag class="starttag">item</tag> element contains
+ * <tag class="starttag">attribute</tag> and <tag class="starttag">link</tag>
+ * elements with a mandatory name attribute.
+ * <tag class="starttag">link</tag> elements have the same content
+ * model as <tag class="starttag">menu</tag>.
+ *
+ * Attribute values can be translated using gettext, like other #GtkBuilder
+ * content. <tag class="starttag">attribute</tag> elements can be marked for
+ * translation with a <literal>translatable="yes"</literal> attribute.
+ * It is also possible to specify message context and translator comments,
+ * using the context and comments attributes. To make use of this, the
+ * #GtkBuilder must have been given the gettext domain to use.
  */
 
 typedef GSimpleActionGroupClass GtkApplicationWindowActionsClass;